Management API

Base Resource URL:


                    https://[server-name]/api/v01/users/[user-name]

User name of a user, on which action is required.

Resource URL	Description
https://[server-name]/api/v01/users/[user-name]/access-info	Represents access information of the given User.
https://[server-name]/api/v01/users/[user-name]/contact-info	Represents contact information of the given User.
https://[server-name]/api/v01/users/[user-name]/default-merchant	Represents information on the default Merchant, associated with the given user.
https://[server-name]/api/v01/users/[user-name]/merchants	Represents Merchants, associated with the given user.
https://[server-name]/api/v01/users/[user-name]/resellers	Represents Resellers, associated with the given user.

authenticate

Method: GET	Implicit: Yes	Returns: User *
Consumes: xurl		Produces: json, xml

Returns settings of an authenticated user.

Parameters:

#	Name	Type	Required	Default	Description
01	password	String	Yes		User password

delete

Method: DELETE	Implicit: Yes	Returns: ServiceResponse
Consumes: xurl		Produces: json, xml

Deletes a selected user from the system.

load

Method: GET	Implicit: Yes	Returns: User *
Consumes: xurl		Produces: json, xml

Returns settings of a selected user.

modify

Method: POST	Implicit: Yes	Returns: User *
Consumes: json, xml, xurl		Produces: json, xml

Updates existing users with the specified values.

Parameters:

#	Name	Type	Required	Default	Description
01	object	User *	Yes		Updated object information. Represents user of the system.
02	notificationPolicy	User *	No	default	If the "default" value is used, the email notification upon user changing password will be sent out to creator. Represents user of the system.